GET Results
Request the results for a patient that is associated with a LetsGetChecked test kit.
Request
Endpoint
GET {clientId}/api/v1/results/{barcode}?alphaCode={alphaCode}
Path parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| clientId | The clientId is a unique code that is provided by LetsGetChecked. The code is formed by 1 to 4 alphanumeric characters. | string | Required |
| Barcode | Formatted as LGC-0000-0000-0000, where 0 indicates any digit. | string | Required |
| AlphaCode | Formatted as AAAAAA, where A indicates any uppercase letter from A to Z. | string | Optional |
Response
The sample response is a single JSON object that contains the following fields:
| Property | Description | Type |
|---|---|---|
| testResults | The test kit results for the patient. | list of objects(testResult) |
testResult/biomarkerName | The name of the biomarker that is tested. A biomarker is a biological molecule found in blood, other body fluids, or tissues that is a sign of a normal or abnormal process, or of a condition or disease. | string |
testResult/kind | The values can be Qualitative, Quantitative, or Genetic. | string |
testResult/descriptor | A descriptor is a brief description of a test result in a human-readable format. The following descriptors are possible for results with a
The following descriptors are possible for results with a
For test results with a qualitative value, LetsGetChecked recommends that clients should map the | string |
testResult/headline | A brief summary of the test result. | string |
testResult/description | A detailed description of the test results, reported by the LetsGetChecked lab. | string |
testResult/testCode | An identifier for each biomarker in the LetsGetChecked system. The testCode for each biomarker is an internal LetsGetChecked laboratory code. | string |
testResult/QuantitativeValue | Object that contains the numerical result of the test. Certain results can be represented with less than or greater than symbols (< or >) depending on thresholds for measurable ranges for certain biomarkers. | The quantitative value contains the following information:
|
testResult/GeneticValue | The genetic value which can be represented as:
| The genetic value contains the following information:
|
testResult/QualitativeValue | A description of the test result. Note: Results can have a | The qualitative value is an enumerated property that can return one of the following values:
|
testResult/Coding | Contains LOINC (Logical Observation Identifiers names and Codes) information associated with each test result. LOINC is an international standard for identifying health measurements, observations, and documents. | object(coding) |
testResult/coding/system | The URL of the LOINC system. | string |
testResult/coding/code | The LOINC associated with the test kit. | string |
testResult/coding/display | Display Names are concise, clinician-friendly labels for LOINC terms | string |
| patientIdentification | Information that identifies the patient. | object(patientIdentification) |
patientIdentification/firstName | Patient First Name. The maximum length is 100 characters. | string |
patientIdentification/middleName | Patient Middle Name. The maximum length is 100 characters. | string |
patientIdentification/lastName | Patient Last Name. The maximum length is 100 characters. | string |
patientIdentification/dob | Patient Date of Birth. | datetime |
patientIdentification/phone | Patient Phone. | string |
patientIdentification/gender | The Patient gender. Values retrieved: Male, Female. | string |
patientIdentification/resellerId | The Patient ResellerId. This property should not be used as it is deprecated. | string |
patientIdentification/patientResellerPatientId | The Patient Reseller Identifier in the Reseller System. Commonly this value is the value submitted by clients at ordering phase as the Participant Id. | string |
patientIdentification/address | The Patient Address. | object(address) |
patientIdentification/address/postalCode | The Patient Address Postal Code. | string |
patientIdentification/address/countryIsoAlpha2Code | The Patient Address CountryIso2Code. | string |
patientIdentification/address/country | The Patient Human readable country. | string |
patientIdentification/address/line1 | The Patient principal address . | string |
patientIdentification/address/line2 | The Patient secondary address. | string |
patientIdentification/address/city | The Patient City. | string |
patientIdentification/address/areaTitle | The Patient area title. Observation: For US patients, the areaTitle will be a US state. | string |
| clientOrderId | The Client Order ID is a unique code associated with a client. | string |
| timestamp | The date and time at which the results are available. | datetime |
| PhysiciansInfo | The LetsGetChecked physician information for order approval. | object(physiciansInfo) |
physiciansInfo/firstName | The Physician First Name. The maximum length is 100 characters. | string |
physiciansInfo/middleName | The Physician Middle Name. This can have a maximum length of 50 characters. | string |
physiciansInfo/lastName | The Physician Last Name. The maximum length is 100 characters. | string |
physiciansInfo/npId | The Physician NPID. | long |
physiciansInfo/type | The Physician Type. Note: If no NpId is associated to the physician, the value that will appear is 0. | string |
Sample response
{
"testResults":[
{
"biomarkerName:"string",
"kind":"Qualitative"|"Quantitative"|"Genetic",
"descriptor":"string",
"headline":"string",
"description":"string",
"testCode":"string",
"quantitativeValue":{QuantitativeValue},
"geneticValue":{GeneticValue},
"qualitativeValue":"string",
"coding": {Coding}
}],
"patientIdentification":
{
"firstName":"string",
"lastName":"string",
"dob":"string",
"gender":"Male"|"Female"
},
"clientOrderId":"string",
"timeStamp":"datetime",
"physiciansInfo": [
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"npId": long,
"type": "string"
}
]
}
"QuantitativeValue":{
"value":"string",
"unit":"string",
"lowerBound":"number",
"upperBound":"number”
}
GeneticValue:{
"gene":"string",
"genotype":"string",
"phenotypeImageKey":"string",
"phenotypeDescription":"string"
}
enum QualitativeValue {
None,
Cancelled,
TestNotRequired,
Testing,
NotAvailable,
BorderlineReactive,
Reactive,
Detected,
Positive,
NotDetected,
NoSpecimenReceived,
InsufficientSpecimen,
Negative,
NonReactive,
Isolated,
NotIsolated,
AgedSpecimen,
Haemolyzed,
Inconclusive,
InvalidSpecimen,
LabError,
CompromisedSpecimen,
Clotted,
Rejected,
IncorrectTube,
IncorrectVolume,
Unmeasurable,
TimeError,
NoValueCalculated,
InsufficientSerum,
DispatchError,
CollectionError,
InvalidOrder,
SampleIDIssue,
Uncontactable,
Icteric,
Lipemic,
Invalid,
PresumptivePositive,
Equivocal,
PossibleCeliac,
PresumptiveCeliac,
NotLikelyCeliac
}
"Coding": [
{
"system": "string",
"code": "string",
"display": "string"
}
]
Example 1: Diabetes Test - Normal Result
{
"testResults":[
{
"biomarkerName":"HbA1c",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your HbA1c test result has been returned as NORMAL.",
"description":"A normal test result can mean that your average blood sugar level over the last 3 months was within either the normal (<5.7%) or prediabetic (5.7-6.4%) reference range. These ranges are based on the CDC (US) and HSE (Irish) guidelines. Please note prediabetic reference ranges for UK residents are between 6.0% and 6.4%. Results within the prediabetic range can mean that you could be at higher risk for developing diabetes. If you are pregnant it is important to talk to your healthcare provider. If you have an existing diagnosis of diabetes, your HbA1c is within the normal range. The target for people with diabetes is often 7% or less. It is important to know that targets can vary based on your medical history. Your healthcare provider will be able to advise on the best target level for you. This test is not a replacement for regular blood sugar testing at home. Even though this result is normal, if you are experiencing symptoms please share these results with your healthcare provider.",
"testCode":"0111",
"quantitativeValue":{
"value":"4",
"unit":"%",
"lowerBound":0.0,
"upperBound":6.5
},
"geneticValue":null,
"qualitativeValue":null,
"coding": [
{
"system": "https://loinc.org",
"code": "4548-4",
"display": "Hemoglobin A1c"
}
]
}
],
"patientIdentification":{
"resellerId":"00000000-0000-0000-0000-000000000000",
"patientResellerPatientId": "166216",
"firstName":"John",
"middleName":null,
"lastName":"Smith",
"dob":"1990-2-28",
"phone": "+1|987054444",
"gender":"Male",
"address": {
"postalCode": "37072-7369",
"countryIsoAlpha2Code": "US",
"line1": "825 Muller Forge",
"line2": "Suite 826",
"city": "New Simone",
"country": "United States",
"areaTitle": "State"
}
},
"clientOrderId":"731042",
"timeStamp":"2022-01-21T12:10:09.396Z",
"physiciansInfo": [
{
"firstName": "Patrick",
"middleName": "Florine",
"lastName": "Grimes",
"npId": 1000000001,
"type": "OrderPhysician"
}
]
}
Example 2: Diabetes and Heart Test - Normal Result
{
"testResults":[
{
"biomarkerName":"Cholesterol",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your Cholesterol test result has been returned as NORMAL.",
"description":"Your total cholesterol test result is normal. This means that your total cholesterol test result was within the normal range. The total cholesterol level is a combination of both LDL (bad) and HDL (good) cholesterol. It is important to consider the levels of LDL and HDL cholesterol individually when deciding on the best steps to take to improve your health. Ways to maintain desirable cholesterol levels include regular exercise, avoiding excess sugar, and eating healthier unsaturated fats such as those found in fish and plant oils.",
"testCode":"0042",
"quantitativeValue":{
"value":"180",
"unit":"mg/dL",
"lowerBound":0.0,
"upperBound":200.0
},
"geneticValue":null,
"qualitativeValue":null,
"coding": []
},
{
"biomarkerName":"HDL (high density lipoprotein)",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your HDL (high density lipoprotein) test result has been returned as NORMAL.",
"description":"Your high-density lipoprotein (HDL) test result was normal. This means that your HDL levels were within the normal range. Maintaining optimal levels of HDL (good) cholesterol is important in order to lower your risk of developing heart disease and cardiovascular complications such as heart attack and stroke. Ways to maintain optimal HDL cholesterol levels include regular exercise, not smoking, and eating a healthy diet containing “good fats” such as those found in oily fish and plant oils.",
"testCode":"0050",
"quantitativeValue":{
"value":"48",
"unit":"mg/dL",
"lowerBound":40.0,
"upperBound":59.0
},
"geneticValue":null,
"qualitativeValue":null,
"coding": []
},
{
"biomarkerName":"High-Density Lipoprotein (HDL) % of Total Cholesterol",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your High-Density Lipoprotein (HDL) % of Total Cholesterol test result has been returned as NORMAL.",
"description":"Your High-Density Lipoprotein (HDL) % of Total Cholesterol test result was normal. This means that your HDL (high-density lipoprotein) % of total cholesterol was within the normal range. Total cholesterol levels are a combination of HDL (good), LDL (bad) cholesterol, and triglycerides. This result indicates that you have a normal balance of HDL cholesterol when compared to your total cholesterol levels. When deciding on the next steps to take, this result should be viewed in combination with your other cholesterol test results. Normal levels of HDL % of total cholesterol can be maintained by exercising regularly, not smoking, and eating a healthy diet containing “good fats” such as those found in oily fish and plant oils.",
"testCode":"0049",
"quantitativeValue":{
"value":"70",
"unit":"%",
"lowerBound":20.0,
"upperBound":100.0
},
"geneticValue":null,
"qualitativeValue":null,
"coding": []
},
{
"biomarkerName":"LDL (low density lipoprotein)",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your LDL (low density lipoprotein) test result has been returned as NORMAL.",
"description":"Your LDL (low-density lipoprotein) test result was normal. This means that your LDL (low-density lipoprotein) test result was within the normal range. Maintaining normal levels of LDL (bad) cholesterol is important in order to lower your risk of developing heart disease and cardiovascular complications such as heart attack and stroke. Ways to maintain optimal LDL cholesterol levels include regular exercise, not smoking, and eating a healthy diet containing “good fats” such as those found in oily fish and plant oils. It may also help to avoid eating too much-saturated fat, this is contained in red meat and full-fat dairy products. You may have different target levels for LDL cholesterol if you have a condition that puts you at a higher than average risk for heart disease. If this applies to you please speak to your healthcare provider about your LDL targets.",
"testCode":"0052",
"quantitativeValue":{
"value":"120",
"unit":"mg/dL",
"lowerBound":0.0,
"upperBound":130.0
},
"geneticValue":null,
"qualitativeValue":null,
"coding": []
},
{
"biomarkerName":"Total Triglycerides",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your Total Triglycerides test result has been returned as NORMAL.",
"description":"This means that your total triglycerides were within the normal range. Your body converts any calories it doesn't need into triglycerides and this is stored as fat. Maintaining triglyceride levels within the desirable range is important in order to reduce your risk of developing heart disease and other cardiovascular complications. Ways to maintain desirable triglyceride levels include regular exercise, avoiding excess sugar, and eating healthier unsaturated fats such as those found in fish and plant oils.",
"testCode":"0058",
"quantitativeValue":{
"value":"140",
"unit":"mg/dL",
"lowerBound":0.0,
"upperBound":150.0
},
"geneticValue":null,
"qualitativeValue":null,
"coding": []
},
{
"biomarkerName":"HbA1c",
"kind":"Quantitative",
"descriptor":"Normal",
"headline":"Your HbA1c test result has been returned as NORMAL.",
"description":"A normal test result can mean that your average blood sugar level over the last 3 months was within either the normal (<5.7%) or prediabetic (5.7-6.4%) reference range. These ranges are based on the CDC (US) and HSE (Irish) guidelines. Please note prediabetic reference ranges for UK residents are between 6.0% and 6.4%. Results within the prediabetic range can mean that you could be at higher risk for developing diabetes. If you are pregnant it is important to talk to your healthcare provider. If you have an existing diagnosis of diabetes, your HbA1c is within the normal range. The target for people with diabetes is often 7% or less. It is important to know that targets can vary based on your medical history. Your healthcare provider will be able to advise on the best target level for you. This test is not a replacement for regular blood sugar testing at home. Even though this result is normal, if you are experiencing symptoms please share these results with your healthcare provider.",
"testCode":"0111",
"quantitativeValue":{
"value":"4",
"unit":"mg/dL",
"lowerBound":0.0,
"upperBound":6.5
},
"geneticValue":null,
"qualitativeValue":null,
"coding": []
}
],
"patientIdentification":{
"resellerId":"00000000-0000-0000-0000-000000000000",
"patientResellerPatientId":"166216",
"firstName":"John",
"middleName":null,
"lastName":"Smith",
"dob":"1990-2-28",
"phone": "+1|987054444",
"gender":"Male",
"address": {
"postalCode": "37072-7369",
"countryIsoAlpha2Code": "US",
"line1": "825 Muller Forge",
"line2": "Suite 826",
"city": "New Simone",
"country": "United States",
"areaTitle": "State"
}
},
"clientOrderId":"0e788588-d39d-40b1-a590-67ec250a2853",
"timeStamp":"2022-01-07T14:30:46.03Z",
"physiciansInfo": [
{
"firstName": "Patrick",
"middleName": "Florine",
"lastName": "Grimes",
"npId": 1000000001,
"type": "OrderPhysician"
}]
}
Example 3: Positive COVID-19 Result
{
"testResults":[
{
"biomarkerName":"Coronavirus COVID-19",
"kind":"Qualitative",
"descriptor":"Positive",
"headline":"Your Coronavirus COVID-19 test result has been returned as POSITIVE.",
"description":"This is a positive coronavirus test result. This means you have tested positive for the form of coronavirus that causes COVID-19. You should tell your healthcare provider about this result. You will need to stay in self-isolation. This means you will need to stay at home and stay away from other people in your home. You will also need to follow the advice provided by your doctor and local health department. You should watch for symptoms of COVID-19. These include fever, cough or breathing difficulties. Most people who get coronavirus will not get very bad symptoms. If you feel very unwell or if you find it hard to breathe you should call your healthcare provider right away. If it's an emergency, call the emergency services.",
"testCode":"0211",
"quantitativeValue":null,
"geneticValue":null,
"qualitativeValue":"Positive",
"coding": []
}
],
"patientIdentification":{
"resellerId":"00000000-0000-0000-0000-000000000000",
"patientResellerPatientId": "166216",
"firstName":"John",
"middleName":null,
"lastName":"Smith",
"dob":"1990-2-28",
"phone": "+1|987054444",
"gender":"Male",
"address": {
"postalCode": "37072-7369",
"countryIsoAlpha2Code": "US",
"line1": "825 Muller Forge",
"line2": "Suite 826",
"city": "New Simone",
"country": "United States",
"areaTitle": "State"
}
},
"clientOrderId":"0e788588-d39d-40b1-a590-67ec250a2854",
"timeStamp":"2022-01-07T11:59:48.058Z",
"physiciansInfo": [
{
"firstName": "Patrick",
"middleName": "Florine",
"lastName": "Grimes",
"npId": 1000000001,
"type": "OrderPhysician"
}]
}
